﻿#region Copyright
// Copyright (c) 2011-2012 RaisingForce Team (Alikin Sergey)
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
#endregion

using System.Diagnostics.Contracts;
using RaisingForce.Raise.Measures;

namespace RaisingForce.Raise.Hardware
{
    /// <summary>
    /// Представляет интерфейс доступа к оборудованию робота.
    /// </summary>
    /// <remarks>
    /// Все методы и свойства интерфейса могут быть вызваны асинхронно
    /// из разных потоков для объекта, реализующего интерфейс.
    /// Требуется обеспечить их потокобезопасность.
    /// <para>Для упрощения реализации интерфейса следует унаследовать
    /// класс реализации от абстрактного класса <see cref="RobotHardware"/>.</para>
    /// </remarks>
    [ContractClass(typeof(IRobotHardwareContract))]
    public interface IRobotHardware
    {
        /// <summary>
        /// Получает имя интерфейса, дружественное для пользователя.
        /// </summary>
        /// <value>Имя интерфейса, дружественное для пользователя.
        /// Если это значение равно <c>null</c> или пустой строке, то для отображения используется
        /// информация, полученная из атрибута <see cref="RobotHardwareAttribute"/>.</value>
        string Name { get; }

        /// <summary>
        /// Получает описание интерфейса, дружественное для пользователя.
        /// </summary>
        /// <value>Описание интерфейса, дружественное для пользователя.
        /// Если это значение равно <c>null</c> или пустой строке, то для отображения используется
        /// информация, полученная из атрибута <see cref="RobotHardwareAttribute"/>.</value>
        string Description { get; }

        /// <summary>
        /// Получает интерфейс доступа к двигателю робота.
        /// </summary>
        /// <value>Интерфейс доступа к двигателю робота.
        /// Это значение не может быть равно null.</value>
        /// <remarks>Данное свойство может быть вызвано только после того,
        /// как выполнен метод <c>IRobotHardware.Initialize()</c>.
        /// Свойство не должно вызывать исключений.</remarks>
        /// <seealso cref="IRobotHardware"/>
        IRobotEngine Engine { get; }

        /// <summary>
        /// Получает интерфейс доступа к ультразвуковому датчику робота.
        /// </summary>
        /// <value>Интерфейс доступа к ультразвуковому датчику робота.
        /// Это значение не может быть равно null.</value>
        /// <remarks>Данное свойство может быть вызвано только после того,
        /// как выполнен метод <c>IRobotHardware.Initialize()</c>.
        /// Свойство не должно вызывать исключений.</remarks>
        /// <seealso cref="IRobotHardware"/>
        IRobotSensor Sensor { get; }

        /// <summary>
        /// Выполняет проверку наличия совместимого для работы с роботом оборудования 
        /// и инициализацию начального состояния данного интерфейса.
        /// </summary>
        /// <param name="options">Параметры, используемые для настройки действий робота.</param>
        /// <exception cref="RobotHardwareException">
        /// Совместимое для работы с роботом оборудование не найдено,
        /// либо инициализация начального состояния невозможна.
        /// </exception>
        /// <remarks>
        /// <para>Данный метод вызывается единственный раз в процессе работы
        /// программы перед обращением к другим методам интерфейса <c>IRobotHardware</c>.
        /// В нем можно разместить отложенную инициализацию параметров,
        /// необходимых для работы с роботом, вместо того, чтобы делать
        /// это в конструкторе класса.</para>
        /// <para>В случае невозможности успешного выполнения задачи
        /// (например из-за отсутствия поддержки Bluetooth на компьютере)
        /// метод должен выбрасывать исключение <c>RobotHardwareException</c>.
        /// Другие типы исключений недопустимы.</para>
        /// </remarks>
        /// <seealso cref="IRobotHardware"/>
        /// <seealso cref="RobotHardwareException"/>
        void Initialize(IRobotHardwareOptions options);

        /// <summary>
        /// Устанавливает соединение с роботом через Bluetooth или другой интерфейс.
        /// </summary>
        /// <exception cref="RobotHardwareException">
        /// Соединение с роботом установить невозможно.
        /// </exception>
        /// <remarks>
        /// <para>Данный метод вызывается только в случае, когда соединение с роботом
        /// не было установлено, т.е. либо сразу после вызова метода <c>IRobotHardware.Initialize()</c>,
        /// либо после предварительного вызова <c>IRobotHardware.Disconnect()</c>.</para>
        /// <para>В случае невозможности успешного выполнения задачи
        /// (например из-за отсутствия подходящего робота)
        /// метод должен выбрасывать исключение <c>RobotHardwareException</c>.
        /// Другие типы исключений недопустимы.</para>
        /// </remarks>
        /// <seealso cref="IRobotHardware"/>
        /// <seealso cref="RobotHardwareException"/>
        void Connect();

        /// <summary>
        /// Прерывает ранее установленное соединение с роботом.
        /// </summary>
        /// <exception cref="RobotHardwareException">
        /// Ошибка при попытке прервать соединение.
        /// </exception>
        /// <remarks>
        /// <para>Данный метод вызывается только в том случае, когда соединение
        /// с роботом уже было установлено, т.е. после предварительного
        /// вызова <c>IRobotHardware.Disconnect()</c>.</para>
        /// <para>В случае невозможности успешного выполнения задачи
        /// (например из-за неверной реакции оборудование на запрос)
        /// метод должен выбрасывать исключение <c>RobotHardwareException</c>.
        /// Другие типы исключений недопустимы.</para>
        /// </remarks>
        /// <seealso cref="IRobotHardware"/>
        /// <seealso cref="RobotHardwareException"/>
        void Disconnect();
    }
}
